Show:

ia.Indicator Class

Extends ia.BaseData
Defined in: ia\data\Indicator.js:1
Module: ia

Contains information about an indicator.

Constructor

ia.Indicator

(
  • geography
  • theme
  • data
)

Defined in ia\data\Indicator.js:1

Parameters:

  • geography ia.Geography

    The geography the indicator belongs to.

  • theme ia.Theme

    The theme the indicator belongs to.

  • data JSON

    The json data describing the object.

Methods

getAssociate

(
  • associateName
)
ia.Associate

Defined in ia\data\Indicator.js:246

Returns the associate that corresponds to the name.

Parameters:

  • associateName String

    The associate name.

Returns:

ia.Associate: An associate.

getAssociates

() ia.Associate[]

Defined in ia\data\Indicator.js:255

Returns the associates contained in the indicator.

Returns:

ia.Associate[]: An array of associates.

getChildren

() Object

Inherited from ia.BaseData: ia\data\BaseData.js:185

Returns an array of data objects that are children of this object.

Returns:

Object: An array of data objects.

getComparisonData

() Associative Array

Defined in ia\data\Indicator.js:396

Returns a hashtable of the indicator plus associate comparison data.

The returned data has the following structure:

["eh11"]{id:"eh11", name:"polwarth", value:2345, value_formatted:2345, associate1:25, associate1_formatted:25}
["eh12"]{id:"eh12", name:"morningside", value:4347, value_formatted:4347, associate1:45, associate1_formatted:45}
["eh13"]{id:"eh13", name:"merchiston", value:2496, value_formatted:2496, associate1:25, associate1_formatted:25}

Returns:

Associative Array: As described above.

getComparisonValue

(
  • id
)
Number | String

Defined in ia\data\Indicator.js:200

Returns the comparison value that corresponds to the feature id.

Parameters:

  • id String

    The feature id.

Returns:

Number | String: The value for the given id.

getComparisonValues

() Number | String

Defined in ia\data\Indicator.js:215

Returns the list of comparison values.

Returns:

Number | String: An array of values.

getData

(
  • associateNames
  • featureIds
)
Object

Defined in ia\data\Indicator.js:489

Gets the indicators associate comparison data.

Parameters:

  • associateNames String

    An optional list of associate ids.

  • featureIds String

    An optional list of feature ids to get data for.

Returns:

Object: An array of data objects.

getData

(
  • associateNames
  • featureIds
)
Object

Defined in ia\data\Indicator.js:451

Gets the indicators associate data.

Parameters:

  • associateNames String

    An optional list of associate ids.

  • featureIds String

    An optional list of feature ids to get data for.

Returns:

Object: An array of data objects.

getData

(
  • featureIds
)
Associative Array

Defined in ia\data\Indicator.js:310

Returns a hashtable of the indicator plus associate data.

The returned data has the following structure:

["eh11"]{id:"eh11", name:"polwarth", value:2345, value_formatted:2345, associate1:25, associate1_formatted:25}
["eh12"]{id:"eh12", name:"morningside", value:4347, value_formatted:4347, associate1:45, associate1_formatted:45}
["eh13"]{id:"eh13", name:"merchiston", value:2496, value_formatted:2496, associate1:25, associate1_formatted:25}

Parameters:

  • featureIds String

    An optional list of feature ids to get data for.

Returns:

Associative Array: As described above.

getDataPrecision

(
  • dataField
)
Number

Defined in ia\data\Indicator.js:287

Gets the data precision for the passed data field.

Parameters:

  • dataField String

    The data field as a String eg "value"; "associate1"; "name" etc.

Returns:

Number: The data precision or undefined.

getDataTree

(
  • showDates
  • reverseDates
  • dataHash
  • parentId
)

Inherited from ia.BaseData: ia\data\BaseData.js:193

Returns an associative array of the form:

["i1"]{id:"i1"; label:"Home"; type:"branch"; children:["i2"; "i3"; "i4"]}
["i2"]{id:"i2"; label:"ia.Indicator 1"; type:"branch"; parent:"i1"; children:["i5"; "i6"; "i7"]}
["i5"]{id:"i5~2004"; label:"2004"; type:"leaf"; parent:"i2"}

Used by data explorers. Dates are returned as part of the tree.

Parameters:

  • showDates Boolean

    Should the dates be displayed.

  • reverseDates Boolean

    Should the dates be reversed.

  • dataHash Associative Array

    An associative array as described.

  • parentId String

    The parent id.

getDataType

(
  • dataField
)
String

Defined in ia\data\Indicator.js:263

Gets the data type for the passed data field.

Parameters:

  • dataField String

    The data field as a String eg "value"; "associate1"; "name" etc.

Returns:

String: The data type or undefined.

getFormattedComparisonValue

(
  • id
)
String

Defined in ia\data\Indicator.js:223

Returns the formatted comparison value that corresponds to the feature id.

Parameters:

  • id String

    The feature id.

Returns:

String: The formatted value for the given id.

getFormattedComparisonValues

() String

Defined in ia\data\Indicator.js:238

Returns the list of formatted comparison values.

Returns:

String: An array of formatted values.

getFormattedValue

(
  • id
)
String

Defined in ia\data\Indicator.js:178

Returns the formatted value that corresponds to the feature id. Will also return a comparison value.

Parameters:

  • id String

    The feature id.

Returns:

String: The formatted value for the given id.

getFormattedValues

() String

Defined in ia\data\Indicator.js:192

Returns the list of formatted values.

Returns:

String: An array of formatted values.

getLowerLimits

() ia.Limits

Defined in ia\data\Indicator.js:140

Returns the lower limits

Returns:

ia.Limits: A Limits object.

getProperties

() Associative Array

Inherited from ia.BaseData: ia\data\BaseData.js:177

Returns the custom properties. An associative array of the form: [propName] = propValue.

Returns:

Associative Array: The properties.

getProperty

(
  • propName
)
Number | String

Inherited from ia.BaseData: ia\data\BaseData.js:168

Returns a value for a custom property.

Parameters:

  • propName String

    The name of the property.

Returns:

Number | String: The value of the property, or undefined if it doesnt exist.

getUpperLimits

() ia.Limits

Defined in ia\data\Indicator.js:148

Returns the upper limits

Returns:

ia.Limits: A Limits object.

getValue

(
  • id
)
Number | String

Defined in ia\data\Indicator.js:156

Returns the value that corresponds to the feature id. Will also return a comparison value.

Parameters:

  • id String

    The feature id.

Returns:

Number | String: The value for the given id.

getValues

() Number | String

Defined in ia\data\Indicator.js:170

Returns the list of values.

Returns:

Number | String: An array of values.

parseData

(
  • data
)

Defined in ia\data\Indicator.js:53

Parses the JSON data.

Parameters:

  • data JSON

    The json data describing the object.

Properties

customColumns

Object} Array of columns.

Inherited from ia.BaseData: ia\data\BaseData.js:144

The custom columns that can be used in the data table.

data

JSON

Inherited from ia.BaseData: ia\data\BaseData.js:94

The raw json data describing the object.

date

String

Defined in ia\data\Indicator.js:21

The indicator date.

fileName

String

Inherited from ia.BaseData: ia\data\BaseData.js:152

The file name.

geography

ia.Geography

Inherited from ia.BaseData: ia\data\BaseData.js:86

The parent geography.

hasData

Boolean

Inherited from ia.BaseData: ia\data\BaseData.js:102

Indicates if this object contains data.

Default: true

href

String

Inherited from ia.BaseData: ia\data\BaseData.js:127

The href.

id

String

Inherited from ia.BaseData: ia\data\BaseData.js:111

The id.

maxValue

Number

Defined in ia\data\Indicator.js:45

The maximum value.

minValue

Number

Defined in ia\data\Indicator.js:37

The minimum value.

name

String

Inherited from ia.BaseData: ia\data\BaseData.js:119

The name.

parent

Object

Inherited from ia.BaseData: ia\data\BaseData.js:78

The parent object.

precision

Number

Inherited from ia.BaseData: ia\data\BaseData.js:160

The precision. Inherited from parent if undefined.

theme

ia.Theme

Defined in ia\data\Indicator.js:29

The parent theme.

type

Number

Inherited from ia.BaseData: ia\data\BaseData.js:135

The data type. Inherited from parent if undefined.

Default: "categoric"